One exciting feature about CommandBox is the ability to group commands together into a lovingly little file we call, a recipe. We even gave it its own extension, .boxr. This little gem will allow you to automate several commands from your native shell, it will be faster to use our recipe command that allows you to run several CommandBox commands at once. This will allow you to only load the CommandBox engine once for all those commands, but still be dumped back at your native prompt when done. Recipes can also just be useful for a series of commands you run on a regular basis, from test executions, to compressing files, the possibilities are endless.
Below is a simple example of how to create a recipe and execute it. For further insight, we recommend you read our chapter on recipes in our CommandBox book.
How to start?
Recipes are modern batch files or shell scripts for those unix fans.It has the capability to execute commands just like if you are in the shell, have comments and even have the ability to do argument binding. Technically a recipe can have any file extension, but the default recommendation is .boxr which stands for "box recipe". Lines that start with a # will be ignored as comments. just like in many batch files. Here is a nice example:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
# Named paramecho "Hello $name, we are ready to start your recipe"# Positional paramecho "Hello $1, we are ready to start your recipe"# Start with an empty folderrm mySite --recurse --forcemkdir mySitecd mySite# Initialize this folder as a packageinit name=mySite version=1.0.0 slug=mySlug# Scaffold out a site and a handlercoldbox create app mySitecoldbox create handler myHandler index# Add some required packageinstall coldboxinstall cbmessagebox,cbstorages,cbvaidation# Set the default portpackage set defaultPort=8081# Start up the embedded serverstart |
Executing Your Recipe
You will use the recipe command in order to execute recipes. You can find much more information about the recipe command by typing recipe help or visiting the API Docs.
recipe myrecipe.boxr
If you have named parameters you would execute it like this:
recipe recipeFile=myrecipe.boxr name=Luis
If you have positional parameters you would execute it like this:
recipe myrecipe.boxr Luis
As you can see, very nicely you can bind your recipes with dynamic content and automate pretty much anything. We even have a contribution type in ForgeBox for all CommandBox recipes, so please share them with the world.
Add Your Comment
(2)
Dec 03, 2018 09:36:48 UTC
by Travis
Links on this post are broken.
Dec 03, 2018 16:00:06 UTC
by Brad Wood
Thanks, I've updated the links.